home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / telecomm / fnordadl / fn132bin.zoo / man / configur.man < prev    next >
Encoding:
Text File  |  1991-09-02  |  5.6 KB  |  138 lines
  1.  
  2.  
  3. CONFIGUR(1)          FNORDADEL BBS SOFTWARE           CONFIGUR(1)
  4.  
  5. NAME
  6.      configur.tos - configuration program for Fnordadel
  7.  
  8. SYNOPSIS
  9.      configur [X] [-c] [+] [+{var}] [+{novar}] [+{var=value}]
  10.      [...]
  11.  
  12. DESCRIPTION
  13.      Configur reads the file ctdlcnfg.sys which it expects to
  14.      find in the current directory (the directory in which confi-
  15.      gur is run).  It will create any system data files which
  16.      need to be created and will scan currently existing data
  17.      files.  Configur produces ctdltabl.sys which is used by
  18.      citadel.tos and by many Fnordadel utilities.  If configur is
  19.      being run for the first time, it will attempt to create the
  20.      following files:
  21.  
  22.      #msgdir\ctdlmsg.sys
  23.      #sysdir\ctdllog.sys
  24.      #sysdir\ctdlflr.sys
  25.      #roomdir\room0000.sys ... roomnnnn.sys
  26.      #netdir\ctdlnet.sys
  27.  
  28.      Configur, when invoked with no arguments or only "-c", will
  29.      ask the Sysop if he or she wants to wipe clean some or all
  30.      of the above data files.
  31.  
  32. OPTIONS
  33.      X    If this or any other dummy parameter is present confi-
  34.           gur will assume that it is running unattended and will
  35.           not ask if .sys files are to be changed or wiped clean.
  36.  
  37.      -c   This tells configur to use the "checkpoint" file
  38.           (checkpt.sys in the #sysdir) to drastically speed up
  39.           the scan of the message base when configur starts its
  40.           run.  However, if there is corruption in your message
  41.           base this feature may do more harm than good.  On the
  42.           other (and rarer) hand, checkpointing may save your
  43.           bacon with certain sorts of corruption.
  44.  
  45.      The why of things is this: configur needs to find out what
  46.      the newest and oldest messages are in your message base.
  47.      Normally, it will start at sector 0 of the message file and
  48.      scan every message until the file's end, recording the
  49.      newest and oldest message numbers found.  This is the "brute
  50.      force and ignorance" approach; it takes time, but is nor-
  51.      mally secure.
  52.  
  53.      On the speedier side, we do know something about the struc-
  54.      ture of the message file: the oldest message will always
  55.      follow the newest one, due to the cirular nature of the mes-
  56.      sage base.  Even better, each time we save a message into
  57.      the file, we know where the newest message went, and its
  58.      message ID#.  So Fnordadel writes this information into the
  59.      checkpt.sys file so that configur can read it and find the
  60.      exact place to start its scan.
  61.  
  62.      Normally, with no errors, the newest message will thus be
  63.      the first one read, and the oldest will be the second one
  64.      read.  If they don't match what checkpt.sys says they should
  65.      be, configur knows something is wrong and keeps scanning
  66.      trying to find the right values.  It will generate an error
  67.      message if it can't find what checkpt.sys says the right
  68.      values should be.  In such a case, you should probably rerun
  69.      without -c.
  70.  
  71.      +    This has the effect of re-reading the ctdlcnfg.sys file
  72.           and changing the variables stored in ctdltabl.sys
  73.           accordingly.  It does not scan data files and therefore
  74.           is used only when changing cosmetic variable values.
  75.  
  76.      +var This has the effect of setting the binary switch 'var'
  77.           to 1 (i.e. turning on the particular feature).
  78.  
  79.      +novar
  80.           This has the opposite effect of the above (i.e. it
  81.           turns off the variable 'var').  Note the lack of a
  82.           space between
  83.  
  84.      +var=value
  85.           This is used to change a non-binary numeric variable.
  86.           The variable 'var' is set to the value 'value'.
  87.  
  88.      The last three '+' arguments are used to change cosmetic
  89.      variables on the fly.  To make the changes permanent,
  90.      ctdlcnfg.sys should be edited to reflect the new values.
  91.  
  92. NOTES
  93.      Configur will tell you if it runs into anything abnormal,
  94.      like a missing data file, misconfigured variable, et cetera.
  95.      If it thinks the error is serious enough (which is usual)
  96.      then configur will stop right there and let you fix it.
  97.  
  98.      PLEASE ensure that the configuration file (ctdlcnfg.sys)
  99.      matches reality (i.e. what is in the system files).  If you
  100.      use a Fnordadel utility to, say, change the number of rooms
  101.      in the system, ensure that you've changed the appropriate
  102.      value in ctdlcnfg.sys BEFORE you run configur again.  Nasty
  103.      things WILL happen if you don't!
  104.  
  105.      There is no way to change string variables on-the-fly with
  106.      the "+var=value" notation.  You have to edit ctdlcnfg.sys
  107.      for that; and indeed, we recommend not being cute with the
  108.      [+var...] arguments and just sticking to editing
  109.      ctdlcnfg.sys.  Life will be less confusing that way.
  110.  
  111.      While configur is processing the rooms of an existing setup,
  112.      it will check for empty "temporary" type rooms.  Any such
  113.      rooms that it finds will be purged from the system.
  114.  
  115. FILES
  116.      configur.tos   Configuration program.
  117.      ctdlcnfg.sys   List of customizing information.
  118.      ctdltabl.sys   Tables file read and written by citadel.tos
  119.                     and regenerated by configur.
  120.      checkpt.sys    The checkpoint file, in #sysdir.
  121.  
  122. SEE ALSO
  123.      ctdlcnfg.doc   A fully-commented version of ctdlcnfg.sys.
  124.      The Fnordadel Reference Manual
  125.  
  126. AUTHORS
  127.      Configur is one of the original Citadel programs, and prob-
  128.      ably still contains original CrT code.
  129.  
  130.      Lots of it was written by Hue, Jr., for Citadel-86.
  131.  
  132.      It was extensively hacked by David Parsons for STadel.
  133.  
  134.      And, it was hacked yet again by Adrian Ashley and Royce How-
  135.      land for the Fnordadel system, including a major rearrange-
  136.      ment and rehashing by AA.
  137.  
  138.